Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Jump to bottom

Add initial support to represent diagrams with Mermaid #89

Open
wants to merge 1 commit into
base: master
Choose a base branch
from
Open

Add initial support to represent diagrams with Mermaid #89

wants to merge 1 commit into from

Conversation

dplanella
Copy link
Contributor

@dplanella dplanella commented Jun 4, 2019 •
edited
Loading

Adds support for generating diagrams with Mermaid for easier maintenance and for lowering the barrier to documentation contributions.

Notes:

  • I only replaced one diagram for now to gather feedback. If this change is accepted, happy to convert the rest to Mermaid as well.
  • The diagram can be displayed top-down as well (less compact, better for mobile view) by replacing the graph LR line by graph TD

@acs
Copy link
Member

acs commented Jun 4, 2019

Pretty cool. I need to play with mermaid to understand its full capabilities. Thanks @dplanella

@valeriocos
Copy link
Member

-1 , I would prefer to replace the diagrams with artworks (pngs files derived from svg ones) as proposed at: #6

@dplanella
Copy link
Contributor Author

Thanks for the reviews. The ideas behind it were to ultimately lower the barrier for contribution, as:

  • Bitmaps are not accessible
  • Not everyone feels comfortable with using an SVG editor, but everyone can use a text editor to generate or update the diagrams
  • Enables contributors to edit the diagrams online with the GitHub web UI.
  • The diagram at [grimoirelab] Restyle grimoirelab-all-complete image #6 could still be used as a nicer representation of how all the tools/backends work together, as an overview on the tutorial landing page.

@dplanella
Copy link
Contributor Author

@acs @valeriocos @jgbarah any further thoughts on this PR? Thanks.

@valeriocos
Copy link
Member

I'm fine with any decision @dplanella :)

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Reviewers
No reviews
Assignees
No one assigned
Labels
None yet
Projects
None yet
Milestone
No milestone
Development

Successfully merging this pull request may close these issues.
3 participants
@dplanella @acs @valeriocos